***************************************************************************
***                            #QuizPL TeaM                             ***
***                                                                     ***
***                  Najlepszy kanał quizowy na IRC-u!                  ***
***************************************************************************
***                       https://www.quizpl.net                        ***
***                         kontakt@quizpl.net                          ***
***************************************************************************

Witaj drogi Quizowiczu. Oto instrukcja, dzięki której będziesz mógł/mogła samodzielnie napisać i puścić swoją premierę 
quizową na kanale #QuizPL. :)

Pełny poradnik znajdziesz pod adresem: https://www.quizpl.net/poradnik

############################
### I. Instalacja mIRCa. ###
############################

Jeśli masz już ściągniętego i poprawnie skonfigurowanego mIRCa możesz pominąć ten punkt i po uruchomieniu mIRCa dodać 
do ulubionych kanał #QuizPL oraz wejść na kanał poleceniem /join #QuizPL


Aby zaś ściągnąć mIRCa i móc grać na kanale #QuizPL wykonaj poniższe kroki:

1. Ściągnij plik https://www.quizpl.net/viewforum.php?f=79
2. Rozpakuj powyższy plik do dowolnego katalogu, np. C:\Program Files\
3. Przeczytaj zamieszczony tam plik "-= Przeczytaj mnie =-.txt"
4. Uruchom plik mIRC.exe
5. Kliknij teraz na pierwszą ikonkę pod menu (tą z piorunkiem) lub wpisz na dole "/server polska.irc.pl" (bez 
   cudzysłowu) i wciśnij enter. Jeśli połączyłeś się z serwerem i automatycznie otworzyło się nowe okienko, to jesteś 
   już na kanale #QuizPL i od teraz możesz zdobywać punkciki!


Alternatywnie możesz ściągnąć mIRCa ze strony autora programu https://www.mirc.com/get.html lecz wówczas musisz 
samodzielnie skonfigurować program lub napisać na adres kontakt@quizpl.net by uzyskać naszą pomoc.

###############################
### II. Instalacja skryptu. ###
###############################

Rozpakuj to archiwum i przenieś wszystkie pliki do głównego katalogu mIRCa, np. C:\Program Files\mIRC\ oraz uruchom 
plik mirc.exe

Teraz, by móc korzystać ze skryptu (w dniu puszczania quizu), należy go wgrać do uruchomionego wcześniej mIRCa. 
Uzyskasz to poleceniem:

/load -rs familiada.als

W okienku statusu powinien pojawić się podobny do tego napis:

* Loaded script 'C:\...\familiada.als'

#############################################
### III. Przygotowanie pliku z pytaniami. ###
#############################################

Ten rodzaj quizu polega na rozgrywce drużynowej, ale klasyfikacja jest liczona także indywidualnie. Stanowi on formułę 
pośrednią między quizem tematycznym i ogólnym, bowiem na każde pytanie jest do 10 odpowiedzi.

Gdy zdecydujesz się napisać swój quiz i puścić go na kanale - wybierz sobie dziedzinę z jakiej chciałbyś napisać quiz 
(może być także wiedza ogólna).

Plik z pytaniami musi być w odpowiedniej postaci. Format pliku polega na tym, że pytania i zestaw do 10 odpowiedzi na 
każde pytanie, oddzielonych od siebie znakiem gwiazdki ("*"), umieszczamy naprzemiennie w kolejnych linijkach 
zakończonych enterem. Przykład:

Wymien planety Ukladu Slonecznego
Merkury*Wenus*Ziemia*Mars*Jowisz*Saturn*Uran*Neptun*Pluton
Elementy zestawu komputerowego
klawiatura*monitor*myszka*glosniki*mikrofon*panel lcd*komputer

Przykładowy quiz znajdziesz w pliku "przyklad.txt", zaznajom się z nim.


Podstawowe zasady układania quizów:

- format pliku musi być poprawny, bo quiz utknie na błędnym pytaniu (unikaj zbędnych spacji i wystrzegaj się pustych 
  linii)
- nie używaj w pytaniach i odpowiedziach znaków diakrytycznych (ą, ć, ę, ł, ń, ó, ś, ź, ż)
- pytania i odpowiedzi nie mogą zawierać błędów ortograficznych, stylistycznych, interpunkcyjnych i merytorycznych
- pytania zaczynaj wielką literą, a odpowiedzi małą, chyba że są to nazwy własne
- unikaj długich odpowiedzi, najlepiej niech mają góra 1-2 wyrazy
- nie pisz zbyt długich, opisowych pytań - skonkretyzuj je


Gdy już utworzysz zestaw ok. 25 pytań (na przykład w windowsowym notatniku, ale nie w Wordzie!), to zapisz je w pliku, 
w głównym katalogu z mIRCem. Pamiętaj jednak by nazwa pliku nie zawierała spacji.

################################
### IV. Puszczenie premiery. ###
################################

Kiedy napiszesz już quiz i ustalisz z operatorami kanału dzień i godzinę premiery - możesz przystąpić do jej 
realizacji w wyznaczonym terminie. Nie zapomnij tylko o wgraniu skryptu (patrz punkt II). ;)

Skrypt zawiera wiele poleceń. Pełną ich listę uzyskasz poleceniem: /fkom

Aby uruchomić quiz otwórz okno kanału #QuizPL i wpisz:

/fon #QuizPL

Teraz gracze mają czas na wybranie jednej z dwóch drużyn, w której chcą grać i możliwość jej nazwania.

Gdy zdecydujesz, że wszyscy zapięli pasy ;) i chcą grać, wpisz poniższe polecenie (otworzy się jednocześnie okienko 
wyboru pliku z pytaniami):

/fauto

W razie potrzeby możesz zwiększyć opóźnienie między poszczególnymi pytaniami (domyślnie jest to 15 sekund) poleceniem: 
/fauto 20 (pierwsze wywołanie wczytuje pytania z pliku i uruchamia quiz), bądź użyć osobnego polecenia: /fdelay 20 
Czas trwania rundy (domyślnie jest to 120 sekund) możesz zmienić poleceniem: /fczas 90

*** Teraz gracze grają i cieszą się z Twojej premiery. ;) ***

Jeśli pytanie okazało się trudne i gracze mają z nim kłopot, to możesz im pomóc wyświetlając podpowiedzi poniższym 
poleceniem. Miej jednak na uwadze, że polecenie to odsłoni po literce z każdej nieodgadniętej odpowiedzi.

/fpodp

Po zakończeniu premiery trzeba wyświetlić wyniki. Uczynisz to poleceniem:

/fwynik

Na koniec zamykasz quiz poleceniem:

/foff


Po zakończeniu i zamknięciu quizu możesz (zalecane), ale nie musisz wyładować skrypt z mIRCa. Dokonasz tego 
poleceniem:

/unload -rs familiada.als

Aby puścić kolejną premierkę należy ponownie wgrać skrypt poleceniem /load (patrz punkt II).


Uwaga, nie zapomnij by po zakończeniu premiery przysłać plik z pytaniami, temat quizu wraz z datą puszczenia oraz 
pełne wyniki na adres kanałowy: kontakt@quizpl.net Pytania zostaną wówczas dodane do bazy naszego quizbota i wszyscy 
będą mogli się nimi cieszyć jeszcze przez długie lata ;)

##############################
### V. Polecenia kanałowe. ###
##############################

W trakcie trwania premiery quizowej dla graczy dostępne są specjalne polecenia. Pamiętaj, że z uwagi na specyficzny 
sposób funkcjonowania mIRCa te polecenia nie są dostępne dla puszczającego premierę.

Wejście do drużyny pierwszej: !join 1

Wejście do drużyny drugiej: !join 2

Opuszczenie drużyny: !part

Zmiana nazwy drużyny (dostępne tylko dla pierwszej osoby w każdej z drużyn): !team nazwa

Wyświetlenie sobie punktacji drużynowej i własnej: !pkt

Przypomnienie pytania: !przyp

#################################
### VI. Informacje dodatkowe. ###
#################################

Na każde pytanie może być do 10 odpowiedzi. Punktacja odpowiedzi zależy od jej pozycji na liście odpowiedzi. Pierwsza 
(lewa) jest zawsze za 50 punktów, a każda kolejna za 5 punktów mniej, aż do 5 punktów za dziesiątą odpowiedź (ale 
może być ich mniej).

###################################
### VII. Informacje o skrypcie. ###
###################################

Wersja: Familiada 0.68
Autor: snajperx
Rozbudowa: wilk (wyniki indywidualne, podsumowanie gry, liczenie odpowiedzi, podpowiedzi, ustawianie czasu trwania 
   rundy, kolorowe znaczki drużyn, komunikaty o wejściu i wyjściu z drużyny, naprawione wychodzenie z drużyny)


Miłej zabawy życzy,
Ekipa #QuizPL.
